/*
 * YAJHFC - Yet another Java Hylafax client
 * Copyright (C) 2005-2011 Jonas Wolz <info@yajhfc.de>
 *
 *  This program is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation, either version 3 of the License, or
 *  (at your option) any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *  
 *  Linking YajHFC statically or dynamically with other modules is making 
 *  a combined work based on YajHFC. Thus, the terms and conditions of 
 *  the GNU General Public License cover the whole combination.
 *  In addition, as a special exception, the copyright holders of YajHFC 
 *  give you permission to combine YajHFC with modules that are loaded using
 *  the YajHFC plugin interface as long as such plugins do not attempt to
 *  change the application's name (for example they may not change the main window title bar 
 *  and may not replace or change the About dialog).
 *  You may copy and distribute such a system following the terms of the
 *  GNU GPL for YajHFC and the licenses of the other code concerned,
 *  provided that you include the source code of that other code when 
 *  and as the GNU GPL requires distribution of source code.
 *  
 *  Note that people who make modified versions of YajHFC are not obligated to grant 
 *  this special exception for their modified versions; it is their choice whether to do so.
 *  The GNU General Public License gives permission to release a modified 
 *  version without this exception; this exception also makes it possible 
 *  to release a modified version which carries forward this exception.
 */
package yajhfc.model.servconn.defimpl;

import javax.swing.SwingUtilities;

import yajhfc.model.servconn.ConnectionState;
import yajhfc.model.servconn.FaxListConnectionListener;

/**
 * FaxListConnectionListener that makes sure the event processing is done
 * in the event dispatching thread.
 * 
 * @author jonas
 *
 */
public abstract class SwingFaxListConnectionListener implements
        FaxListConnectionListener {
    public boolean enableConnectionStateChange;
    public boolean enableServerStatusChange;
    public boolean enableRefreshComplete;
    
    
    protected void connectionStateChangeSwing(ConnectionState oldState, ConnectionState newState) {
        // Do nothing
    }

    /* (non-Javadoc)
     * @see yajhfc.model.servconn.FaxListConnectionListener#connectionStateChange(yajhfc.model.servconn.ConnectionState, yajhfc.model.servconn.ConnectionState)
     */
    public final void connectionStateChange(final ConnectionState oldState,
            final ConnectionState newState) {
        if (!enableConnectionStateChange)
            return;
        
        if (SwingUtilities.isEventDispatchThread()) {
            connectionStateChangeSwing(oldState, newState);
        } else {
            SwingUtilities.invokeLater(new Runnable() {
               public void run() {
                   connectionStateChangeSwing(oldState, newState);
                } 
            });
        }
    }
    
    protected void serverStatusChangedSwing(String statusText) {
        // Do nothing
    }
    
    /* (non-Javadoc)
     * @see yajhfc.model.servconn.FaxListConnectionListener#serverStatusChanged(java.lang.String)
     */
    public final void serverStatusChanged(final String statusText) {
        if (!enableServerStatusChange)
            return;
        
        if (SwingUtilities.isEventDispatchThread()) {
            serverStatusChangedSwing(statusText);
        } else {
            SwingUtilities.invokeLater(new Runnable() {
               public void run() {
                   serverStatusChangedSwing(statusText);
                } 
            });
        }
    }
    
    public final void refreshComplete(final RefreshKind refreshKind, final boolean success) {
        if (!enableRefreshComplete)
            return;
        
        if (SwingUtilities.isEventDispatchThread()) {
            refreshCompleteSwing(refreshKind, success);
        } else {
            SwingUtilities.invokeLater(new Runnable() {
               public void run() {
                   refreshCompleteSwing(refreshKind, success);
                } 
            });
        }
    }
    
    protected void refreshCompleteSwing(RefreshKind refreshKind, boolean success) {
        // NOP
    }

    public SwingFaxListConnectionListener() {
        this(true,true,true);
    }

    public SwingFaxListConnectionListener(boolean enableConnectionStateChange,
            boolean enableServerStatusChange, boolean enableRefreshComplete) {
        super();
        this.enableConnectionStateChange = enableConnectionStateChange;
        this.enableServerStatusChange = enableServerStatusChange;
        this.enableRefreshComplete = enableRefreshComplete;
    }


    
}
